

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>The web module &mdash; pyamp v1.2 documentation</title>
    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../',
        VERSION:     '1.2',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="../_static/jquery.js"></script>
    <script type="text/javascript" src="../_static/underscore.js"></script>
    <script type="text/javascript" src="../_static/doctools.js"></script>
    <link rel="top" title="pyamp v1.2 documentation" href="../index.html" />
    <link rel="up" title="The web module" href="mod_pyamp_web.html" />
    <link rel="next" title="The networking module" href="mod_pyamp_networking.html" />
    <link rel="prev" title="The hacking module" href="pyamp_web_hacking.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="mod_pyamp_networking.html" title="The networking module"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="pyamp_web_hacking.html" title="The hacking module"
             accesskey="P">previous</a> |</li>
        <li><a href="../index.html">pyamp v1.2 documentation</a> &raquo;</li>
          <li><a href="mod_pyamp.html" >The pyamp module</a> &raquo;</li>
          <li><a href="mod_pyamp_web.html" accesskey="U">The web module</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="module-pyamp.web.web">
<span id="the-web-module"></span><h1>The web module<a class="headerlink" href="#module-pyamp.web.web" title="Permalink to this headline">¶</a></h1>
<p>The web module provides classes, and functions which provide
various functionality respective to websites.</p>
<div class="section" id="the-urlrequest-class">
<h2>The UrlRequest class<a class="headerlink" href="#the-urlrequest-class" title="Permalink to this headline">¶</a></h2>
<p class="graphviz">
<img src="../_images/inheritance-dc8c2b697285ca5555d5e95b977f44192e038270.png" alt="Inheritance diagram of pyamp.web.web.UrlRequest" usemap="#inheritance1fe4677926" class="inheritance"/>
<map id="inheritance1fe4677926" name="inheritance1fe4677926">
<area shape="rect" href="../web.html#pyamp.web.web.UrlRequest" title="pyamp.web.web.UrlRequest" alt="" coords="5,7,200,33"/>
</map>
</p>
<dl class="class">
<dt id="pyamp.web.web.UrlRequest">
<em class="property">class </em><tt class="descclassname">pyamp.web.web.</tt><tt class="descname">UrlRequest</tt><a class="reference internal" href="../_modules/pyamp/web/web.html#UrlRequest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.web.web.UrlRequest" title="Permalink to this definition">¶</a></dt>
<dd><p>The UrlRequest provides methods for requesting webpages.</p>
<dl class="classmethod">
<dt id="pyamp.web.web.UrlRequest.authenticate">
<em class="property">classmethod </em><tt class="descname">authenticate</tt><big>(</big><em>username</em>, <em>password</em>, <em>url</em><big>)</big><a class="reference internal" href="../_modules/pyamp/web/web.html#UrlRequest.authenticate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.web.web.UrlRequest.authenticate" title="Permalink to this definition">¶</a></dt>
<dd><p>Request a page that requires authentication.</p>
</dd></dl>

<dl class="classmethod">
<dt id="pyamp.web.web.UrlRequest.get">
<em class="property">classmethod </em><tt class="descname">get</tt><big>(</big><em>url</em><big>)</big><a class="reference internal" href="../_modules/pyamp/web/web.html#UrlRequest.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.web.web.UrlRequest.get" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the content of a page.</p>
</dd></dl>

<dl class="classmethod">
<dt id="pyamp.web.web.UrlRequest.request">
<em class="property">classmethod </em><tt class="descname">request</tt><big>(</big><em>url</em><big>)</big><a class="reference internal" href="../_modules/pyamp/web/web.html#UrlRequest.request"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.web.web.UrlRequest.request" title="Permalink to this definition">¶</a></dt>
<dd><p>Request a page.</p>
</dd></dl>

</dd></dl>

</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h3><a href="../index.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">The web module</a><ul>
<li><a class="reference internal" href="#the-urlrequest-class">The UrlRequest class</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="pyamp_web_hacking.html"
                        title="previous chapter">The hacking module</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="mod_pyamp_networking.html"
                        title="next chapter">The networking module</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="../_sources/_generated/pyamp_web_web.txt"
           rel="nofollow">Show Source</a></li>
  </ul>
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" size="18" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="mod_pyamp_networking.html" title="The networking module"
             >next</a> |</li>
        <li class="right" >
          <a href="pyamp_web_hacking.html" title="The hacking module"
             >previous</a> |</li>
        <li><a href="../index.html">pyamp v1.2 documentation</a> &raquo;</li>
          <li><a href="mod_pyamp.html" >The pyamp module</a> &raquo;</li>
          <li><a href="mod_pyamp_web.html" >The web module</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2012, Brett Ponsler.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.1.
    </div>
  </body>
</html>